Documentation

Developers

IntroductionAuthentication

Featured Endpoints

Checkouts

Customer Portal

Customer-Sessions

Customers

Discounts

License Keys

Oauth2

Organizations

Products

Issue Funding Endpoints

External Organizations

Repositories

Other Endpoints

Advertisements

Benefits

Checkout-Links

Checkouts

Custom-Fields

Customer Portal

Files

Metrics

Oauth2

Orders

List OrdersGET
Get OrderGET
Get Order InvoiceGET

Subscriptions

orders

Get Order

get
/v1/orders/{id}
Get an order by ID.
Methods
OpenID Connect
Personal Access Token
Subjects
Organization
User
Scopes
orders:read
The order ID.
Successful Response
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Key-value object storing custom field values.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the product.
The name of the product.
The description of the product.
Whether the product is a subscription tier.
Whether the product is archived and no longer available.
The ID of the organization owning the product.
curl -X GET \
    'https://api.polar.sh/v1/orders/00000000-0000-0000-0000-000000000000' \
    -H "Accept: application/json" \
    -H "Authorization: Bearer <token>" \
Responses
{
  "created_at": "2025-01-03T00:00:00.000Z",
  "modified_at": "2025-01-03T00:00:00.000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "metadata": {},
  "custom_field_data": {},
  "amount": 0,
  "tax_amount": 0,
  "currency": "string",
  "billing_reason": "purchase",
  "billing_address": {
    "line1": "string",
    "line2": "string",
    "postal_code": "string",
    "city": "string",
    "state": "string",
    "country": "string"
  },
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "product_id": "00000000-0000-0000-0000-000000000000",
  "product_price_id": "00000000-0000-0000-0000-000000000000",
  "discount_id": "00000000-0000-0000-0000-000000000000",
  "subscription_id": "00000000-0000-0000-0000-000000000000",
  "checkout_id": "00000000-0000-0000-0000-000000000000",
  "customer": {
    "created_at": "2025-01-03T00:00:00.000Z",
    "modified_at": "2025-01-03T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "email": "string",
    "email_verified": false,
    "name": "string",
    "billing_address": {
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "city": "string",
      "state": "string",
      "country": "string"
    },
    "tax_id": [
      "string",
      "ad_nrt"
    ],
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "avatar_url": "string"
  },
  "user_id": "00000000-0000-0000-0000-000000000000",
  "user": {
    "id": "00000000-0000-0000-0000-000000000000",
    "email": "string",
    "public_name": "string",
    "avatar_url": "string",
    "github_username": "string"
  },
  "product": {
    "created_at": "2025-01-03T00:00:00.000Z",
    "modified_at": "2025-01-03T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "is_recurring": false,
    "is_archived": false,
    "organization_id": "00000000-0000-0000-0000-000000000000"
  },
  "product_price": {
    "created_at": "2025-01-03T00:00:00.000Z",
    "modified_at": "2025-01-03T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "amount_type": "fixed",
    "is_archived": false,
    "product_id": "00000000-0000-0000-0000-000000000000",
    "price_currency": "string",
    "price_amount": 0,
    "type": "recurring",
    "recurring_interval": "month"
  },
  "discount": {
    "duration": "once",
    "type": "fixed",
    "amount": 0,
    "currency": "string",
    "created_at": "2025-01-03T00:00:00.000Z",
    "modified_at": "2025-01-03T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "name": "string",
    "code": "string",
    "starts_at": "2025-01-03T00:00:00.000Z",
    "ends_at": "2025-01-03T00:00:00.000Z",
    "max_redemptions": 0,
    "redemptions_count": 0,
    "organization_id": "00000000-0000-0000-0000-000000000000"
  },
  "subscription": {
    "metadata": {},
    "created_at": "2025-01-03T00:00:00.000Z",
    "modified_at": "2025-01-03T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "amount": 0,
    "currency": "string",
    "recurring_interval": "month",
    "status": "incomplete",
    "current_period_start": "2025-01-03T00:00:00.000Z",
    "current_period_end": "2025-01-03T00:00:00.000Z",
    "cancel_at_period_end": false,
    "started_at": "2025-01-03T00:00:00.000Z",
    "ended_at": "2025-01-03T00:00:00.000Z",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "product_id": "00000000-0000-0000-0000-000000000000",
    "price_id": "00000000-0000-0000-0000-000000000000",
    "discount_id": "00000000-0000-0000-0000-000000000000",
    "checkout_id": "00000000-0000-0000-0000-000000000000",
    "user_id": "00000000-0000-0000-0000-000000000000"
  }
}